home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / python2.4 / logging / __init__.pyo (.txt) < prev    next >
Python Compiled Bytecode  |  2005-10-18  |  43KB  |  1,388 lines

  1. # Source Generated with Decompyle++
  2. # File: in.pyo (Python 2.4)
  3.  
  4. """
  5. Logging package for Python. Based on PEP 282 and comments thereto in
  6. comp.lang.python, and influenced by Apache's log4j system.
  7.  
  8. Should work under Python versions >= 1.5.2, except that source line
  9. information is not available unless 'sys._getframe()' is.
  10.  
  11. Copyright (C) 2001-2004 Vinay Sajip. All Rights Reserved.
  12.  
  13. To use, simply 'import logging' and log away!
  14. """
  15. import sys
  16. import os
  17. import types
  18. import time
  19. import string
  20. import cStringIO
  21. import traceback
  22.  
  23. try:
  24.     import codecs
  25. except ImportError:
  26.     codecs = None
  27.  
  28.  
  29. try:
  30.     import thread
  31.     import threading
  32. except ImportError:
  33.     thread = None
  34.  
  35. __author__ = 'Vinay Sajip <vinay_sajip@red-dove.com>'
  36. __status__ = 'beta'
  37. __version__ = '0.4.9.6'
  38. __date__ = '27 March 2005'
  39. if hasattr(sys, 'frozen'):
  40.     _srcfile = 'logging%s__init__%s' % (os.sep, __file__[-4:])
  41. elif string.lower(__file__[-4:]) in [
  42.     '.pyc',
  43.     '.pyo']:
  44.     _srcfile = __file__[:-4] + '.py'
  45. else:
  46.     _srcfile = __file__
  47. _srcfile = os.path.normcase(_srcfile)
  48.  
  49. def currentframe():
  50.     """Return the frame object for the caller's stack frame."""
  51.     
  52.     try:
  53.         raise 'catch me'
  54.     except:
  55.         return sys.exc_traceback.tb_frame.f_back
  56.  
  57.  
  58. if hasattr(sys, '_getframe'):
  59.     currentframe = sys._getframe
  60.  
  61. _startTime = time.time()
  62. raiseExceptions = 1
  63. CRITICAL = 50
  64. FATAL = CRITICAL
  65. ERROR = 40
  66. WARNING = 30
  67. WARN = WARNING
  68. INFO = 20
  69. DEBUG = 10
  70. NOTSET = 0
  71. _levelNames = {
  72.     CRITICAL: 'CRITICAL',
  73.     ERROR: 'ERROR',
  74.     WARNING: 'WARNING',
  75.     INFO: 'INFO',
  76.     DEBUG: 'DEBUG',
  77.     NOTSET: 'NOTSET',
  78.     'CRITICAL': CRITICAL,
  79.     'ERROR': ERROR,
  80.     'WARN': WARNING,
  81.     'WARNING': WARNING,
  82.     'INFO': INFO,
  83.     'DEBUG': DEBUG,
  84.     'NOTSET': NOTSET }
  85.  
  86. def getLevelName(level):
  87.     '''
  88.     Return the textual representation of logging level \'level\'.
  89.  
  90.     If the level is one of the predefined levels (CRITICAL, ERROR, WARNING,
  91.     INFO, DEBUG) then you get the corresponding string. If you have
  92.     associated levels with names using addLevelName then the name you have
  93.     associated with \'level\' is returned.
  94.  
  95.     If a numeric value corresponding to one of the defined levels is passed
  96.     in, the corresponding string representation is returned.
  97.  
  98.     Otherwise, the string "Level %s" % level is returned.
  99.     '''
  100.     return _levelNames.get(level, 'Level %s' % level)
  101.  
  102.  
  103. def addLevelName(level, levelName):
  104.     """
  105.     Associate 'levelName' with 'level'.
  106.  
  107.     This is used when converting levels to text during message formatting.
  108.     """
  109.     _acquireLock()
  110.     
  111.     try:
  112.         _levelNames[level] = levelName
  113.         _levelNames[levelName] = level
  114.     finally:
  115.         _releaseLock()
  116.  
  117.  
  118. _lock = None
  119.  
  120. def _acquireLock():
  121.     '''
  122.     Acquire the module-level lock for serializing access to shared data.
  123.  
  124.     This should be released with _releaseLock().
  125.     '''
  126.     global _lock
  127.     if not _lock and thread:
  128.         _lock = threading.RLock()
  129.     
  130.     if _lock:
  131.         _lock.acquire()
  132.     
  133.  
  134.  
  135. def _releaseLock():
  136.     '''
  137.     Release the module-level lock acquired by calling _acquireLock().
  138.     '''
  139.     if _lock:
  140.         _lock.release()
  141.     
  142.  
  143.  
  144. class LogRecord:
  145.     '''
  146.     A LogRecord instance represents an event being logged.
  147.  
  148.     LogRecord instances are created every time something is logged. They
  149.     contain all the information pertinent to the event being logged. The
  150.     main information passed in is in msg and args, which are combined
  151.     using str(msg) % args to create the message field of the record. The
  152.     record also includes information such as when the record was created,
  153.     the source line where the logging call was made, and any exception
  154.     information to be logged.
  155.     '''
  156.     
  157.     def __init__(self, name, level, pathname, lineno, msg, args, exc_info):
  158.         '''
  159.         Initialize a logging record with interesting information.
  160.         '''
  161.         ct = time.time()
  162.         self.name = name
  163.         self.msg = msg
  164.         if args and len(args) == 1 and args[0] and type(args[0]) == types.DictType:
  165.             args = args[0]
  166.         
  167.         self.args = args
  168.         self.levelname = getLevelName(level)
  169.         self.levelno = level
  170.         self.pathname = pathname
  171.         
  172.         try:
  173.             self.filename = os.path.basename(pathname)
  174.             self.module = os.path.splitext(self.filename)[0]
  175.         except:
  176.             self.filename = pathname
  177.             self.module = 'Unknown module'
  178.  
  179.         self.exc_info = exc_info
  180.         self.exc_text = None
  181.         self.lineno = lineno
  182.         self.created = ct
  183.         self.msecs = (ct - long(ct)) * 1000
  184.         self.relativeCreated = (self.created - _startTime) * 1000
  185.         if thread:
  186.             self.thread = thread.get_ident()
  187.             self.threadName = threading.currentThread().getName()
  188.         else:
  189.             self.thread = None
  190.             self.threadName = None
  191.         if hasattr(os, 'getpid'):
  192.             self.process = os.getpid()
  193.         else:
  194.             self.process = None
  195.  
  196.     
  197.     def __str__(self):
  198.         return '<LogRecord: %s, %s, %s, %s, "%s">' % (self.name, self.levelno, self.pathname, self.lineno, self.msg)
  199.  
  200.     
  201.     def getMessage(self):
  202.         '''
  203.         Return the message for this LogRecord.
  204.  
  205.         Return the message for this LogRecord after merging any user-supplied
  206.         arguments with the message.
  207.         '''
  208.         if not hasattr(types, 'UnicodeType'):
  209.             msg = str(self.msg)
  210.         else:
  211.             
  212.             try:
  213.                 msg = str(self.msg)
  214.             except UnicodeError:
  215.                 msg = self.msg
  216.  
  217.         if self.args:
  218.             msg = msg % self.args
  219.         
  220.         return msg
  221.  
  222.  
  223.  
  224. def makeLogRecord(dict):
  225.     '''
  226.     Make a LogRecord whose attributes are defined by the specified dictionary,
  227.     This function is useful for converting a logging event received over
  228.     a socket connection (which is sent as a dictionary) into a LogRecord
  229.     instance.
  230.     '''
  231.     rv = LogRecord(None, None, '', 0, '', (), None)
  232.     rv.__dict__.update(dict)
  233.     return rv
  234.  
  235.  
  236. class Formatter:
  237.     '''
  238.     Formatter instances are used to convert a LogRecord to text.
  239.  
  240.     Formatters need to know how a LogRecord is constructed. They are
  241.     responsible for converting a LogRecord to (usually) a string which can
  242.     be interpreted by either a human or an external system. The base Formatter
  243.     allows a formatting string to be specified. If none is supplied, the
  244.     default value of "%s(message)\\n" is used.
  245.  
  246.     The Formatter can be initialized with a format string which makes use of
  247.     knowledge of the LogRecord attributes - e.g. the default value mentioned
  248.     above makes use of the fact that the user\'s message and arguments are pre-
  249.     formatted into a LogRecord\'s message attribute. Currently, the useful
  250.     attributes in a LogRecord are described by:
  251.  
  252.     %(name)s            Name of the logger (logging channel)
  253.     %(levelno)s         Numeric logging level for the message (DEBUG, INFO,
  254.                         WARNING, ERROR, CRITICAL)
  255.     %(levelname)s       Text logging level for the message ("DEBUG", "INFO",
  256.                         "WARNING", "ERROR", "CRITICAL")
  257.     %(pathname)s        Full pathname of the source file where the logging
  258.                         call was issued (if available)
  259.     %(filename)s        Filename portion of pathname
  260.     %(module)s          Module (name portion of filename)
  261.     %(lineno)d          Source line number where the logging call was issued
  262.                         (if available)
  263.     %(created)f         Time when the LogRecord was created (time.time()
  264.                         return value)
  265.     %(asctime)s         Textual time when the LogRecord was created
  266.     %(msecs)d           Millisecond portion of the creation time
  267.     %(relativeCreated)d Time in milliseconds when the LogRecord was created,
  268.                         relative to the time the logging module was loaded
  269.                         (typically at application startup time)
  270.     %(thread)d          Thread ID (if available)
  271.     %(threadName)s      Thread name (if available)
  272.     %(process)d         Process ID (if available)
  273.     %(message)s         The result of record.getMessage(), computed just as
  274.                         the record is emitted
  275.     '''
  276.     converter = time.localtime
  277.     
  278.     def __init__(self, fmt = None, datefmt = None):
  279.         '''
  280.         Initialize the formatter with specified format strings.
  281.  
  282.         Initialize the formatter either with the specified format string, or a
  283.         default as described above. Allow for specialized date formatting with
  284.         the optional datefmt argument (if omitted, you get the ISO8601 format).
  285.         '''
  286.         if fmt:
  287.             self._fmt = fmt
  288.         else:
  289.             self._fmt = '%(message)s'
  290.         self.datefmt = datefmt
  291.  
  292.     
  293.     def formatTime(self, record, datefmt = None):
  294.         """
  295.         Return the creation time of the specified LogRecord as formatted text.
  296.  
  297.         This method should be called from format() by a formatter which
  298.         wants to make use of a formatted time. This method can be overridden
  299.         in formatters to provide for any specific requirement, but the
  300.         basic behaviour is as follows: if datefmt (a string) is specified,
  301.         it is used with time.strftime() to format the creation time of the
  302.         record. Otherwise, the ISO8601 format is used. The resulting
  303.         string is returned. This function uses a user-configurable function
  304.         to convert the creation time to a tuple. By default, time.localtime()
  305.         is used; to change this for a particular formatter instance, set the
  306.         'converter' attribute to a function with the same signature as
  307.         time.localtime() or time.gmtime(). To change it for all formatters,
  308.         for example if you want all logging times to be shown in GMT,
  309.         set the 'converter' attribute in the Formatter class.
  310.         """
  311.         ct = self.converter(record.created)
  312.         if datefmt:
  313.             s = time.strftime(datefmt, ct)
  314.         else:
  315.             t = time.strftime('%Y-%m-%d %H:%M:%S', ct)
  316.             s = '%s,%03d' % (t, record.msecs)
  317.         return s
  318.  
  319.     
  320.     def formatException(self, ei):
  321.         '''
  322.         Format and return the specified exception information as a string.
  323.  
  324.         This default implementation just uses
  325.         traceback.print_exception()
  326.         '''
  327.         sio = cStringIO.StringIO()
  328.         traceback.print_exception(ei[0], ei[1], ei[2], None, sio)
  329.         s = sio.getvalue()
  330.         sio.close()
  331.         if s[-1] == '\n':
  332.             s = s[:-1]
  333.         
  334.         return s
  335.  
  336.     
  337.     def format(self, record):
  338.         '''
  339.         Format the specified record as text.
  340.  
  341.         The record\'s attribute dictionary is used as the operand to a
  342.         string formatting operation which yields the returned string.
  343.         Before formatting the dictionary, a couple of preparatory steps
  344.         are carried out. The message attribute of the record is computed
  345.         using LogRecord.getMessage(). If the formatting string contains
  346.         "%(asctime)", formatTime() is called to format the event time.
  347.         If there is exception information, it is formatted using
  348.         formatException() and appended to the message.
  349.         '''
  350.         record.message = record.getMessage()
  351.         if string.find(self._fmt, '%(asctime)') >= 0:
  352.             record.asctime = self.formatTime(record, self.datefmt)
  353.         
  354.         s = self._fmt % record.__dict__
  355.         if record.exc_info:
  356.             if not record.exc_text:
  357.                 record.exc_text = self.formatException(record.exc_info)
  358.             
  359.         
  360.         if record.exc_text:
  361.             if s[-1] != '\n':
  362.                 s = s + '\n'
  363.             
  364.             s = s + record.exc_text
  365.         
  366.         return s
  367.  
  368.  
  369. _defaultFormatter = Formatter()
  370.  
  371. class BufferingFormatter:
  372.     '''
  373.     A formatter suitable for formatting a number of records.
  374.     '''
  375.     
  376.     def __init__(self, linefmt = None):
  377.         '''
  378.         Optionally specify a formatter which will be used to format each
  379.         individual record.
  380.         '''
  381.         if linefmt:
  382.             self.linefmt = linefmt
  383.         else:
  384.             self.linefmt = _defaultFormatter
  385.  
  386.     
  387.     def formatHeader(self, records):
  388.         '''
  389.         Return the header string for the specified records.
  390.         '''
  391.         return ''
  392.  
  393.     
  394.     def formatFooter(self, records):
  395.         '''
  396.         Return the footer string for the specified records.
  397.         '''
  398.         return ''
  399.  
  400.     
  401.     def format(self, records):
  402.         '''
  403.         Format the specified records and return the result as a string.
  404.         '''
  405.         rv = ''
  406.         if len(records) > 0:
  407.             rv = rv + self.formatHeader(records)
  408.             for record in records:
  409.                 rv = rv + self.linefmt.format(record)
  410.             
  411.             rv = rv + self.formatFooter(records)
  412.         
  413.         return rv
  414.  
  415.  
  416.  
  417. class Filter:
  418.     '''
  419.     Filter instances are used to perform arbitrary filtering of LogRecords.
  420.  
  421.     Loggers and Handlers can optionally use Filter instances to filter
  422.     records as desired. The base filter class only allows events which are
  423.     below a certain point in the logger hierarchy. For example, a filter
  424.     initialized with "A.B" will allow events logged by loggers "A.B",
  425.     "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If
  426.     initialized with the empty string, all events are passed.
  427.     '''
  428.     
  429.     def __init__(self, name = ''):
  430.         '''
  431.         Initialize a filter.
  432.  
  433.         Initialize with the name of the logger which, together with its
  434.         children, will have its events allowed through the filter. If no
  435.         name is specified, allow every event.
  436.         '''
  437.         self.name = name
  438.         self.nlen = len(name)
  439.  
  440.     
  441.     def filter(self, record):
  442.         '''
  443.         Determine if the specified record is to be logged.
  444.  
  445.         Is the specified record to be logged? Returns 0 for no, nonzero for
  446.         yes. If deemed appropriate, the record may be modified in-place.
  447.         '''
  448.         if self.nlen == 0:
  449.             return 1
  450.         elif self.name == record.name:
  451.             return 1
  452.         elif string.find(record.name, self.name, 0, self.nlen) != 0:
  453.             return 0
  454.         
  455.         return record.name[self.nlen] == '.'
  456.  
  457.  
  458.  
  459. class Filterer:
  460.     '''
  461.     A base class for loggers and handlers which allows them to share
  462.     common code.
  463.     '''
  464.     
  465.     def __init__(self):
  466.         '''
  467.         Initialize the list of filters to be an empty list.
  468.         '''
  469.         self.filters = []
  470.  
  471.     
  472.     def addFilter(self, filter):
  473.         '''
  474.         Add the specified filter to this handler.
  475.         '''
  476.         if filter not in self.filters:
  477.             self.filters.append(filter)
  478.         
  479.  
  480.     
  481.     def removeFilter(self, filter):
  482.         '''
  483.         Remove the specified filter from this handler.
  484.         '''
  485.         if filter in self.filters:
  486.             self.filters.remove(filter)
  487.         
  488.  
  489.     
  490.     def filter(self, record):
  491.         '''
  492.         Determine if a record is loggable by consulting all the filters.
  493.  
  494.         The default is to allow the record to be logged; any filter can veto
  495.         this and the record is then dropped. Returns a zero value if a record
  496.         is to be dropped, else non-zero.
  497.         '''
  498.         rv = 1
  499.         for f in self.filters:
  500.             if not f.filter(record):
  501.                 rv = 0
  502.                 break
  503.                 continue
  504.         
  505.         return rv
  506.  
  507.  
  508. _handlers = { }
  509. _handlerList = []
  510.  
  511. class Handler(Filterer):
  512.     """
  513.     Handler instances dispatch logging events to specific destinations.
  514.  
  515.     The base handler class. Acts as a placeholder which defines the Handler
  516.     interface. Handlers can optionally use Formatter instances to format
  517.     records as desired. By default, no formatter is specified; in this case,
  518.     the 'raw' message as determined by record.message is logged.
  519.     """
  520.     
  521.     def __init__(self, level = NOTSET):
  522.         '''
  523.         Initializes the instance - basically setting the formatter to None
  524.         and the filter list to empty.
  525.         '''
  526.         Filterer.__init__(self)
  527.         self.level = level
  528.         self.formatter = None
  529.         _acquireLock()
  530.         
  531.         try:
  532.             _handlers[self] = 1
  533.             _handlerList.insert(0, self)
  534.         finally:
  535.             _releaseLock()
  536.  
  537.         self.createLock()
  538.  
  539.     
  540.     def createLock(self):
  541.         '''
  542.         Acquire a thread lock for serializing access to the underlying I/O.
  543.         '''
  544.         if thread:
  545.             self.lock = threading.RLock()
  546.         else:
  547.             self.lock = None
  548.  
  549.     
  550.     def acquire(self):
  551.         '''
  552.         Acquire the I/O thread lock.
  553.         '''
  554.         if self.lock:
  555.             self.lock.acquire()
  556.         
  557.  
  558.     
  559.     def release(self):
  560.         '''
  561.         Release the I/O thread lock.
  562.         '''
  563.         if self.lock:
  564.             self.lock.release()
  565.         
  566.  
  567.     
  568.     def setLevel(self, level):
  569.         '''
  570.         Set the logging level of this handler.
  571.         '''
  572.         self.level = level
  573.  
  574.     
  575.     def format(self, record):
  576.         '''
  577.         Format the specified record.
  578.  
  579.         If a formatter is set, use it. Otherwise, use the default formatter
  580.         for the module.
  581.         '''
  582.         if self.formatter:
  583.             fmt = self.formatter
  584.         else:
  585.             fmt = _defaultFormatter
  586.         return fmt.format(record)
  587.  
  588.     
  589.     def emit(self, record):
  590.         '''
  591.         Do whatever it takes to actually log the specified logging record.
  592.  
  593.         This version is intended to be implemented by subclasses and so
  594.         raises a NotImplementedError.
  595.         '''
  596.         raise NotImplementedError, 'emit must be implemented by Handler subclasses'
  597.  
  598.     
  599.     def handle(self, record):
  600.         '''
  601.         Conditionally emit the specified logging record.
  602.  
  603.         Emission depends on filters which may have been added to the handler.
  604.         Wrap the actual emission of the record with acquisition/release of
  605.         the I/O thread lock. Returns whether the filter passed the record for
  606.         emission.
  607.         '''
  608.         rv = self.filter(record)
  609.         if rv:
  610.             self.acquire()
  611.             
  612.             try:
  613.                 self.emit(record)
  614.             finally:
  615.                 self.release()
  616.  
  617.         
  618.         return rv
  619.  
  620.     
  621.     def setFormatter(self, fmt):
  622.         '''
  623.         Set the formatter for this handler.
  624.         '''
  625.         self.formatter = fmt
  626.  
  627.     
  628.     def flush(self):
  629.         '''
  630.         Ensure all logging output has been flushed.
  631.  
  632.         This version does nothing and is intended to be implemented by
  633.         subclasses.
  634.         '''
  635.         pass
  636.  
  637.     
  638.     def close(self):
  639.         '''
  640.         Tidy up any resources used by the handler.
  641.  
  642.         This version does removes the handler from an internal list
  643.         of handlers which is closed when shutdown() is called. Subclasses
  644.         should ensure that this gets called from overridden close()
  645.         methods.
  646.         '''
  647.         _acquireLock()
  648.         
  649.         try:
  650.             del _handlers[self]
  651.             _handlerList.remove(self)
  652.         finally:
  653.             _releaseLock()
  654.  
  655.  
  656.     
  657.     def handleError(self, record):
  658.         '''
  659.         Handle errors which occur during an emit() call.
  660.  
  661.         This method should be called from handlers when an exception is
  662.         encountered during an emit() call. If raiseExceptions is false,
  663.         exceptions get silently ignored. This is what is mostly wanted
  664.         for a logging system - most users will not care about errors in
  665.         the logging system, they are more interested in application errors.
  666.         You could, however, replace this with a custom handler if you wish.
  667.         The record which was being processed is passed in to this method.
  668.         '''
  669.         if raiseExceptions:
  670.             ei = sys.exc_info()
  671.             traceback.print_exception(ei[0], ei[1], ei[2], None, sys.stderr)
  672.             del ei
  673.         
  674.  
  675.  
  676.  
  677. class StreamHandler(Handler):
  678.     '''
  679.     A handler class which writes logging records, appropriately formatted,
  680.     to a stream. Note that this class does not close the stream, as
  681.     sys.stdout or sys.stderr may be used.
  682.     '''
  683.     
  684.     def __init__(self, strm = None):
  685.         '''
  686.         Initialize the handler.
  687.  
  688.         If strm is not specified, sys.stderr is used.
  689.         '''
  690.         Handler.__init__(self)
  691.         if not strm:
  692.             strm = sys.stderr
  693.         
  694.         self.stream = strm
  695.         self.formatter = None
  696.  
  697.     
  698.     def flush(self):
  699.         '''
  700.         Flushes the stream.
  701.         '''
  702.         self.stream.flush()
  703.  
  704.     
  705.     def emit(self, record):
  706.         '''
  707.         Emit a record.
  708.  
  709.         If a formatter is specified, it is used to format the record.
  710.         The record is then written to the stream with a trailing newline
  711.         [N.B. this may be removed depending on feedback]. If exception
  712.         information is present, it is formatted using
  713.         traceback.print_exception and appended to the stream.
  714.         '''
  715.         
  716.         try:
  717.             msg = self.format(record)
  718.             fs = '%s\n'
  719.             if not hasattr(types, 'UnicodeType'):
  720.                 self.stream.write(fs % msg)
  721.             else:
  722.                 
  723.                 try:
  724.                     self.stream.write(fs % msg)
  725.                 except UnicodeError:
  726.                     self.stream.write(fs % msg.encode('UTF-8'))
  727.  
  728.             self.flush()
  729.         except:
  730.             self.handleError(record)
  731.  
  732.  
  733.  
  734.  
  735. class FileHandler(StreamHandler):
  736.     '''
  737.     A handler class which writes formatted logging records to disk files.
  738.     '''
  739.     
  740.     def __init__(self, filename, mode = 'a', encoding = None):
  741.         '''
  742.         Open the specified file and use it as the stream for logging.
  743.         '''
  744.         if codecs is None:
  745.             encoding = None
  746.         
  747.         if encoding is None:
  748.             stream = open(filename, mode)
  749.         else:
  750.             stream = codecs.open(filename, mode, encoding)
  751.         StreamHandler.__init__(self, stream)
  752.         self.baseFilename = os.path.abspath(filename)
  753.         self.mode = mode
  754.  
  755.     
  756.     def close(self):
  757.         '''
  758.         Closes the stream.
  759.         '''
  760.         self.flush()
  761.         self.stream.close()
  762.         StreamHandler.close(self)
  763.  
  764.  
  765.  
  766. class PlaceHolder:
  767.     '''
  768.     PlaceHolder instances are used in the Manager logger hierarchy to take
  769.     the place of nodes for which no loggers have been defined. This class is
  770.     intended for internal use only and not as part of the public API.
  771.     '''
  772.     
  773.     def __init__(self, alogger):
  774.         '''
  775.         Initialize with the specified logger being a child of this placeholder.
  776.         '''
  777.         self.loggers = [
  778.             alogger]
  779.  
  780.     
  781.     def append(self, alogger):
  782.         '''
  783.         Add the specified logger as a child of this placeholder.
  784.         '''
  785.         if alogger not in self.loggers:
  786.             self.loggers.append(alogger)
  787.         
  788.  
  789.  
  790. _loggerClass = None
  791.  
  792. def setLoggerClass(klass):
  793.     '''
  794.     Set the class to be used when instantiating a logger. The class should
  795.     define __init__() such that only a name argument is required, and the
  796.     __init__() should call Logger.__init__()
  797.     '''
  798.     global _loggerClass
  799.     if klass != Logger:
  800.         if not issubclass(klass, Logger):
  801.             raise TypeError, 'logger not derived from logging.Logger: ' + klass.__name__
  802.         
  803.     
  804.     _loggerClass = klass
  805.  
  806.  
  807. def getLoggerClass():
  808.     '''
  809.     Return the class to be used when instantiating a logger.
  810.     '''
  811.     return _loggerClass
  812.  
  813.  
  814. class Manager:
  815.     '''
  816.     There is [under normal circumstances] just one Manager instance, which
  817.     holds the hierarchy of loggers.
  818.     '''
  819.     
  820.     def __init__(self, rootnode):
  821.         '''
  822.         Initialize the manager with the root node of the logger hierarchy.
  823.         '''
  824.         self.root = rootnode
  825.         self.disable = 0
  826.         self.emittedNoHandlerWarning = 0
  827.         self.loggerDict = { }
  828.  
  829.     
  830.     def getLogger(self, name):
  831.         '''
  832.         Get a logger with the specified name (channel name), creating it
  833.         if it doesn\'t yet exist. This name is a dot-separated hierarchical
  834.         name, such as "a", "a.b", "a.b.c" or similar.
  835.  
  836.         If a PlaceHolder existed for the specified name [i.e. the logger
  837.         didn\'t exist but a child of it did], replace it with the created
  838.         logger and fix up the parent/child references which pointed to the
  839.         placeholder to now point to the logger.
  840.         '''
  841.         rv = None
  842.         _acquireLock()
  843.         
  844.         try:
  845.             if self.loggerDict.has_key(name):
  846.                 rv = self.loggerDict[name]
  847.                 if isinstance(rv, PlaceHolder):
  848.                     ph = rv
  849.                     rv = _loggerClass(name)
  850.                     rv.manager = self
  851.                     self.loggerDict[name] = rv
  852.                     self._fixupChildren(ph, rv)
  853.                     self._fixupParents(rv)
  854.                 
  855.             else:
  856.                 rv = _loggerClass(name)
  857.                 rv.manager = self
  858.                 self.loggerDict[name] = rv
  859.                 self._fixupParents(rv)
  860.         finally:
  861.             _releaseLock()
  862.  
  863.         return rv
  864.  
  865.     
  866.     def _fixupParents(self, alogger):
  867.         '''
  868.         Ensure that there are either loggers or placeholders all the way
  869.         from the specified logger to the root of the logger hierarchy.
  870.         '''
  871.         name = alogger.name
  872.         i = string.rfind(name, '.')
  873.         rv = None
  874.         while i > 0 and not rv:
  875.             substr = name[:i]
  876.             if not self.loggerDict.has_key(substr):
  877.                 self.loggerDict[substr] = PlaceHolder(alogger)
  878.             else:
  879.                 obj = self.loggerDict[substr]
  880.                 if isinstance(obj, Logger):
  881.                     rv = obj
  882.                 else:
  883.                     obj.append(alogger)
  884.             i = string.rfind(name, '.', 0, i - 1)
  885.         if not rv:
  886.             rv = self.root
  887.         
  888.         alogger.parent = rv
  889.  
  890.     
  891.     def _fixupChildren(self, ph, alogger):
  892.         '''
  893.         Ensure that children of the placeholder ph are connected to the
  894.         specified logger.
  895.         '''
  896.         for c in ph.loggers:
  897.             if string.find(c.parent.name, alogger.name) != 0:
  898.                 alogger.parent = c.parent
  899.                 c.parent = alogger
  900.                 continue
  901.         
  902.  
  903.  
  904.  
  905. class Logger(Filterer):
  906.     '''
  907.     Instances of the Logger class represent a single logging channel. A
  908.     "logging channel" indicates an area of an application. Exactly how an
  909.     "area" is defined is up to the application developer. Since an
  910.     application can have any number of areas, logging channels are identified
  911.     by a unique string. Application areas can be nested (e.g. an area
  912.     of "input processing" might include sub-areas "read CSV files", "read
  913.     XLS files" and "read Gnumeric files"). To cater for this natural nesting,
  914.     channel names are organized into a namespace hierarchy where levels are
  915.     separated by periods, much like the Java or Python package namespace. So
  916.     in the instance given above, channel names might be "input" for the upper
  917.     level, and "input.csv", "input.xls" and "input.gnu" for the sub-levels.
  918.     There is no arbitrary limit to the depth of nesting.
  919.     '''
  920.     
  921.     def __init__(self, name, level = NOTSET):
  922.         '''
  923.         Initialize the logger with a name and an optional level.
  924.         '''
  925.         Filterer.__init__(self)
  926.         self.name = name
  927.         self.level = level
  928.         self.parent = None
  929.         self.propagate = 1
  930.         self.handlers = []
  931.         self.disabled = 0
  932.  
  933.     
  934.     def setLevel(self, level):
  935.         '''
  936.         Set the logging level of this logger.
  937.         '''
  938.         self.level = level
  939.  
  940.     
  941.     def debug(self, msg, *args, **kwargs):
  942.         '''
  943.         Log \'msg % args\' with severity \'DEBUG\'.
  944.  
  945.         To pass exception information, use the keyword argument exc_info with
  946.         a true value, e.g.
  947.  
  948.         logger.debug("Houston, we have a %s", "thorny problem", exc_info=1)
  949.         '''
  950.         if self.manager.disable >= DEBUG:
  951.             return None
  952.         
  953.         if DEBUG >= self.getEffectiveLevel():
  954.             apply(self._log, (DEBUG, msg, args), kwargs)
  955.         
  956.  
  957.     
  958.     def info(self, msg, *args, **kwargs):
  959.         '''
  960.         Log \'msg % args\' with severity \'INFO\'.
  961.  
  962.         To pass exception information, use the keyword argument exc_info with
  963.         a true value, e.g.
  964.  
  965.         logger.info("Houston, we have a %s", "interesting problem", exc_info=1)
  966.         '''
  967.         if self.manager.disable >= INFO:
  968.             return None
  969.         
  970.         if INFO >= self.getEffectiveLevel():
  971.             apply(self._log, (INFO, msg, args), kwargs)
  972.         
  973.  
  974.     
  975.     def warning(self, msg, *args, **kwargs):
  976.         '''
  977.         Log \'msg % args\' with severity \'WARNING\'.
  978.  
  979.         To pass exception information, use the keyword argument exc_info with
  980.         a true value, e.g.
  981.  
  982.         logger.warning("Houston, we have a %s", "bit of a problem", exc_info=1)
  983.         '''
  984.         if self.manager.disable >= WARNING:
  985.             return None
  986.         
  987.         if self.isEnabledFor(WARNING):
  988.             apply(self._log, (WARNING, msg, args), kwargs)
  989.         
  990.  
  991.     warn = warning
  992.     
  993.     def error(self, msg, *args, **kwargs):
  994.         '''
  995.         Log \'msg % args\' with severity \'ERROR\'.
  996.  
  997.         To pass exception information, use the keyword argument exc_info with
  998.         a true value, e.g.
  999.  
  1000.         logger.error("Houston, we have a %s", "major problem", exc_info=1)
  1001.         '''
  1002.         if self.manager.disable >= ERROR:
  1003.             return None
  1004.         
  1005.         if self.isEnabledFor(ERROR):
  1006.             apply(self._log, (ERROR, msg, args), kwargs)
  1007.         
  1008.  
  1009.     
  1010.     def exception(self, msg, *args):
  1011.         '''
  1012.         Convenience method for logging an ERROR with exception information.
  1013.         '''
  1014.         apply(self.error, (msg,) + args, {
  1015.             'exc_info': 1 })
  1016.  
  1017.     
  1018.     def critical(self, msg, *args, **kwargs):
  1019.         '''
  1020.         Log \'msg % args\' with severity \'CRITICAL\'.
  1021.  
  1022.         To pass exception information, use the keyword argument exc_info with
  1023.         a true value, e.g.
  1024.  
  1025.         logger.critical("Houston, we have a %s", "major disaster", exc_info=1)
  1026.         '''
  1027.         if self.manager.disable >= CRITICAL:
  1028.             return None
  1029.         
  1030.         if CRITICAL >= self.getEffectiveLevel():
  1031.             apply(self._log, (CRITICAL, msg, args), kwargs)
  1032.         
  1033.  
  1034.     fatal = critical
  1035.     
  1036.     def log(self, level, msg, *args, **kwargs):
  1037.         '''
  1038.         Log \'msg % args\' with the integer severity \'level\'.
  1039.  
  1040.         To pass exception information, use the keyword argument exc_info with
  1041.         a true value, e.g.
  1042.  
  1043.         logger.log(level, "We have a %s", "mysterious problem", exc_info=1)
  1044.         '''
  1045.         if type(level) != types.IntType:
  1046.             if raiseExceptions:
  1047.                 raise TypeError, 'level must be an integer'
  1048.             else:
  1049.                 return None
  1050.         
  1051.         if self.manager.disable >= level:
  1052.             return None
  1053.         
  1054.         if self.isEnabledFor(level):
  1055.             apply(self._log, (level, msg, args), kwargs)
  1056.         
  1057.  
  1058.     
  1059.     def findCaller(self):
  1060.         '''
  1061.         Find the stack frame of the caller so that we can note the source
  1062.         file name, line number and function name.
  1063.         '''
  1064.         f = currentframe().f_back
  1065.         while None:
  1066.             co = f.f_code
  1067.             filename = os.path.normcase(co.co_filename)
  1068.             if filename == _srcfile:
  1069.                 f = f.f_back
  1070.                 continue
  1071.             
  1072.             return (filename, f.f_lineno, co.co_name)
  1073.  
  1074.     
  1075.     def makeRecord(self, name, level, fn, lno, msg, args, exc_info):
  1076.         '''
  1077.         A factory method which can be overridden in subclasses to create
  1078.         specialized LogRecords.
  1079.         '''
  1080.         return LogRecord(name, level, fn, lno, msg, args, exc_info)
  1081.  
  1082.     
  1083.     def _log(self, level, msg, args, exc_info = None):
  1084.         '''
  1085.         Low-level logging routine which creates a LogRecord and then calls
  1086.         all the handlers of this logger to handle the record.
  1087.         '''
  1088.         if _srcfile:
  1089.             (fn, lno, func) = self.findCaller()
  1090.         else:
  1091.             (fn, lno, func) = ('(unknown file)', 0, '(unknown function)')
  1092.         if exc_info:
  1093.             if type(exc_info) != types.TupleType:
  1094.                 exc_info = sys.exc_info()
  1095.             
  1096.         
  1097.         record = self.makeRecord(self.name, level, fn, lno, msg, args, exc_info)
  1098.         self.handle(record)
  1099.  
  1100.     
  1101.     def handle(self, record):
  1102.         '''
  1103.         Call the handlers for the specified record.
  1104.  
  1105.         This method is used for unpickled records received from a socket, as
  1106.         well as those created locally. Logger-level filtering is applied.
  1107.         '''
  1108.         if not (self.disabled) and self.filter(record):
  1109.             self.callHandlers(record)
  1110.         
  1111.  
  1112.     
  1113.     def addHandler(self, hdlr):
  1114.         '''
  1115.         Add the specified handler to this logger.
  1116.         '''
  1117.         if hdlr not in self.handlers:
  1118.             self.handlers.append(hdlr)
  1119.         
  1120.  
  1121.     
  1122.     def removeHandler(self, hdlr):
  1123.         '''
  1124.         Remove the specified handler from this logger.
  1125.         '''
  1126.         if hdlr in self.handlers:
  1127.             hdlr.acquire()
  1128.             
  1129.             try:
  1130.                 self.handlers.remove(hdlr)
  1131.             finally:
  1132.                 hdlr.release()
  1133.  
  1134.         
  1135.  
  1136.     
  1137.     def callHandlers(self, record):
  1138.         '''
  1139.         Pass a record to all relevant handlers.
  1140.  
  1141.         Loop through all handlers for this logger and its parents in the
  1142.         logger hierarchy. If no handler was found, output a one-off error
  1143.         message to sys.stderr. Stop searching up the hierarchy whenever a
  1144.         logger with the "propagate" attribute set to zero is found - that
  1145.         will be the last logger whose handlers are called.
  1146.         '''
  1147.         c = self
  1148.         found = 0
  1149.         while c:
  1150.             for hdlr in c.handlers:
  1151.                 found = found + 1
  1152.                 if record.levelno >= hdlr.level:
  1153.                     hdlr.handle(record)
  1154.                     continue
  1155.             
  1156.             if not c.propagate:
  1157.                 c = None
  1158.                 continue
  1159.             c = c.parent
  1160.         if found == 0 and not (self.manager.emittedNoHandlerWarning):
  1161.             sys.stderr.write('No handlers could be found for logger "%s"\n' % self.name)
  1162.             self.manager.emittedNoHandlerWarning = 1
  1163.         
  1164.  
  1165.     
  1166.     def getEffectiveLevel(self):
  1167.         '''
  1168.         Get the effective level for this logger.
  1169.  
  1170.         Loop through this logger and its parents in the logger hierarchy,
  1171.         looking for a non-zero logging level. Return the first one found.
  1172.         '''
  1173.         logger = self
  1174.         while logger:
  1175.             if logger.level:
  1176.                 return logger.level
  1177.             
  1178.             logger = logger.parent
  1179.         return NOTSET
  1180.  
  1181.     
  1182.     def isEnabledFor(self, level):
  1183.         """
  1184.         Is this logger enabled for level 'level'?
  1185.         """
  1186.         if self.manager.disable >= level:
  1187.             return 0
  1188.         
  1189.         return level >= self.getEffectiveLevel()
  1190.  
  1191.  
  1192.  
  1193. class RootLogger(Logger):
  1194.     '''
  1195.     A root logger is not that different to any other logger, except that
  1196.     it must have a logging level and there is only one instance of it in
  1197.     the hierarchy.
  1198.     '''
  1199.     
  1200.     def __init__(self, level):
  1201.         '''
  1202.         Initialize the logger with the name "root".
  1203.         '''
  1204.         Logger.__init__(self, 'root', level)
  1205.  
  1206.  
  1207. _loggerClass = Logger
  1208. root = RootLogger(WARNING)
  1209. Logger.root = root
  1210. Logger.manager = Manager(Logger.root)
  1211. BASIC_FORMAT = '%(levelname)s:%(name)s:%(message)s'
  1212.  
  1213. def basicConfig(**kwargs):
  1214.     """
  1215.     Do basic configuration for the logging system.
  1216.  
  1217.     This function does nothing if the root logger already has handlers
  1218.     configured. It is a convenience method intended for use by simple scripts
  1219.     to do one-shot configuration of the logging package.
  1220.  
  1221.     The default behaviour is to create a StreamHandler which writes to
  1222.     sys.stderr, set a formatter using the BASIC_FORMAT format string, and
  1223.     add the handler to the root logger.
  1224.  
  1225.     A number of optional keyword arguments may be specified, which can alter
  1226.     the default behaviour.
  1227.  
  1228.     filename  Specifies that a FileHandler be created, using the specified
  1229.               filename, rather than a StreamHandler.
  1230.     filemode  Specifies the mode to open the file, if filename is specified
  1231.               (if filemode is unspecified, it defaults to 'a').
  1232.     format    Use the specified format string for the handler.
  1233.     datefmt   Use the specified date/time format.
  1234.     level     Set the root logger level to the specified level.
  1235.     stream    Use the specified stream to initialize the StreamHandler. Note
  1236.               that this argument is incompatible with 'filename' - if both
  1237.               are present, 'stream' is ignored.
  1238.  
  1239.     Note that you could specify a stream created using open(filename, mode)
  1240.     rather than passing the filename and mode in. However, it should be
  1241.     remembered that StreamHandler does not close its stream (since it may be
  1242.     using sys.stdout or sys.stderr), whereas FileHandler closes its stream
  1243.     when the handler is closed.
  1244.     """
  1245.     if len(root.handlers) == 0:
  1246.         filename = kwargs.get('filename')
  1247.         if filename:
  1248.             mode = kwargs.get('filemode', 'a')
  1249.             hdlr = FileHandler(filename, mode)
  1250.         else:
  1251.             stream = kwargs.get('stream')
  1252.             hdlr = StreamHandler(stream)
  1253.         fs = kwargs.get('format', BASIC_FORMAT)
  1254.         dfs = kwargs.get('datefmt', None)
  1255.         fmt = Formatter(fs, dfs)
  1256.         hdlr.setFormatter(fmt)
  1257.         root.addHandler(hdlr)
  1258.         level = kwargs.get('level')
  1259.         if level:
  1260.             root.setLevel(level)
  1261.         
  1262.     
  1263.  
  1264.  
  1265. def getLogger(name = None):
  1266.     '''
  1267.     Return a logger with the specified name, creating it if necessary.
  1268.  
  1269.     If no name is specified, return the root logger.
  1270.     '''
  1271.     if name:
  1272.         return Logger.manager.getLogger(name)
  1273.     else:
  1274.         return root
  1275.  
  1276.  
  1277. def critical(msg, *args, **kwargs):
  1278.     """
  1279.     Log a message with severity 'CRITICAL' on the root logger.
  1280.     """
  1281.     if len(root.handlers) == 0:
  1282.         basicConfig()
  1283.     
  1284.     apply(root.critical, (msg,) + args, kwargs)
  1285.  
  1286. fatal = critical
  1287.  
  1288. def error(msg, *args, **kwargs):
  1289.     """
  1290.     Log a message with severity 'ERROR' on the root logger.
  1291.     """
  1292.     if len(root.handlers) == 0:
  1293.         basicConfig()
  1294.     
  1295.     apply(root.error, (msg,) + args, kwargs)
  1296.  
  1297.  
  1298. def exception(msg, *args):
  1299.     """
  1300.     Log a message with severity 'ERROR' on the root logger,
  1301.     with exception information.
  1302.     """
  1303.     apply(error, (msg,) + args, {
  1304.         'exc_info': 1 })
  1305.  
  1306.  
  1307. def warning(msg, *args, **kwargs):
  1308.     """
  1309.     Log a message with severity 'WARNING' on the root logger.
  1310.     """
  1311.     if len(root.handlers) == 0:
  1312.         basicConfig()
  1313.     
  1314.     apply(root.warning, (msg,) + args, kwargs)
  1315.  
  1316. warn = warning
  1317.  
  1318. def info(msg, *args, **kwargs):
  1319.     """
  1320.     Log a message with severity 'INFO' on the root logger.
  1321.     """
  1322.     if len(root.handlers) == 0:
  1323.         basicConfig()
  1324.     
  1325.     apply(root.info, (msg,) + args, kwargs)
  1326.  
  1327.  
  1328. def debug(msg, *args, **kwargs):
  1329.     """
  1330.     Log a message with severity 'DEBUG' on the root logger.
  1331.     """
  1332.     if len(root.handlers) == 0:
  1333.         basicConfig()
  1334.     
  1335.     apply(root.debug, (msg,) + args, kwargs)
  1336.  
  1337.  
  1338. def log(level, msg, *args, **kwargs):
  1339.     """
  1340.     Log 'msg % args' with the integer severity 'level' on the root logger.
  1341.     """
  1342.     if len(root.handlers) == 0:
  1343.         basicConfig()
  1344.     
  1345.     apply(root.log, (level, msg) + args, kwargs)
  1346.  
  1347.  
  1348. def disable(level):
  1349.     """
  1350.     Disable all logging calls less severe than 'level'.
  1351.     """
  1352.     root.manager.disable = level
  1353.  
  1354.  
  1355. def shutdown():
  1356.     '''
  1357.     Perform any cleanup actions in the logging system (e.g. flushing
  1358.     buffers).
  1359.  
  1360.     Should be called at application exit.
  1361.     '''
  1362.     for h in _handlerList[:]:
  1363.         
  1364.         try:
  1365.             h.flush()
  1366.             h.close()
  1367.         continue
  1368.         continue
  1369.  
  1370.     
  1371.  
  1372.  
  1373. try:
  1374.     import atexit
  1375.     atexit.register(shutdown)
  1376. except ImportError:
  1377.     
  1378.     def exithook(status, old_exit = sys.exit):
  1379.         
  1380.         try:
  1381.             shutdown()
  1382.         finally:
  1383.             old_exit(status)
  1384.  
  1385.  
  1386.     sys.exit = exithook
  1387.  
  1388.